<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>IgH EtherCAT Master: fsm_eoe.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">IgH EtherCAT Master
   &#160;<span id="projectnumber">1.5.2-sncn-5</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>Globals</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('fsm__eoe_8h_source.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<div class="title">fsm_eoe.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="fsm__eoe_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/*****************************************************************************</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> *  $Id$</span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> *  Copyright (C) 2006-2014  Florian Pose, Ingenieurgemeinschaft IgH</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> *  This file is part of the IgH EtherCAT Master.</span></div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"> *  The IgH EtherCAT Master is free software; you can redistribute it and/or</span></div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment"> *  modify it under the terms of the GNU General Public License version 2, as</span></div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment"> *  published by the Free Software Foundation.</span></div><div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"> *  The IgH EtherCAT Master is distributed in the hope that it will be useful,</span></div><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment"> *  but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div><div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment"> *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General</span></div><div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment"> *  Public License for more details.</span></div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="comment"> *  You should have received a copy of the GNU General Public License along</span></div><div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="comment"> *  with the IgH EtherCAT Master; if not, write to the Free Software</span></div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="comment"> *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA</span></div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="comment"> *  ---</span></div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="comment"> *  The license mentioned above concerns the source code only. Using the</span></div><div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="comment"> *  EtherCAT technology and brand is only permitted in compliance with the</span></div><div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="comment"> *  industrial property and similar rights of Beckhoff Automation GmbH.</span></div><div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="comment"> ****************************************************************************/</span></div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;</div><div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="comment">/****************************************************************************/</span></div><div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;</div><div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;<span class="preprocessor">#ifndef __EC_FSM_EOE_H__</span></div><div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;<span class="preprocessor">#define __EC_FSM_EOE_H__</span></div><div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;</div><div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="globals_8h.html">globals.h</a>&quot;</span></div><div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="datagram_8h.html">datagram.h</a>&quot;</span></div><div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="slave_8h.html">slave.h</a>&quot;</span></div><div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="eoe__request_8h.html">eoe_request.h</a>&quot;</span></div><div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;</div><div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;<span class="comment">/****************************************************************************/</span></div><div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;</div><div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="fsm__eoe_8h.html#abf907ba649f2c9f35eab6e36de9b1622">   47</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structec__fsm__eoe.html">ec_fsm_eoe</a> <a class="code" href="structec__fsm__eoe.html">ec_fsm_eoe_t</a>; </div><div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="structec__fsm__eoe.html">   51</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structec__fsm__eoe.html">ec_fsm_eoe</a> {</div><div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="structec__fsm__eoe.html#af0d524bedc30987253f0f6d9167e4ae0">   52</a></span>&#160;    <a class="code" href="structec__slave.html">ec_slave_t</a> *<a class="code" href="structec__fsm__eoe.html#af0d524bedc30987253f0f6d9167e4ae0">slave</a>; </div><div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="structec__fsm__eoe.html#a160de09e919a9acba1428542721dbd27">   53</a></span>&#160;    <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="structec__fsm__eoe.html#a160de09e919a9acba1428542721dbd27">retries</a>; </div><div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="structec__fsm__eoe.html#a9d26ce401611fef24143bdfd1c1937ab">   55</a></span>&#160;    void (*<a class="code" href="structec__fsm__eoe.html#a9d26ce401611fef24143bdfd1c1937ab">state</a>)(<a class="code" href="structec__fsm__eoe.html">ec_fsm_eoe_t</a> *, <a class="code" href="structec__datagram__t.html">ec_datagram_t</a> *); </div><div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="structec__fsm__eoe.html#ab6df3ffa1eaf78631d91aba46525bc3f">   56</a></span>&#160;    <a class="code" href="structec__datagram__t.html">ec_datagram_t</a> *<a class="code" href="structec__fsm__eoe.html#ab6df3ffa1eaf78631d91aba46525bc3f">datagram</a>; </div><div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="structec__fsm__eoe.html#a6a5e047634109a65f38f806be2d6c99d">   57</a></span>&#160;    <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="structec__fsm__eoe.html#a6a5e047634109a65f38f806be2d6c99d">jiffies_start</a>; </div><div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="structec__fsm__eoe.html#ac2f84e2d9a8cf4690925918a807c625d">   58</a></span>&#160;    <a class="code" href="structec__eoe__request__t.html">ec_eoe_request_t</a> *<a class="code" href="structec__fsm__eoe.html#ac2f84e2d9a8cf4690925918a807c625d">request</a>; </div><div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;};</div><div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;</div><div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;<span class="comment">/****************************************************************************/</span></div><div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;</div><div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;<span class="keywordtype">void</span> <a class="code" href="fsm__eoe_8h.html#addd4a112d39ab2ac7dfa3c30d181a2fe">ec_fsm_eoe_init</a>(<a class="code" href="structec__fsm__eoe.html">ec_fsm_eoe_t</a> *);</div><div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;<span class="keywordtype">void</span> <a class="code" href="fsm__eoe_8h.html#a5a213c261d19d01b080ac54b0d71d863">ec_fsm_eoe_clear</a>(<a class="code" href="structec__fsm__eoe.html">ec_fsm_eoe_t</a> *);</div><div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;</div><div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;<span class="keywordtype">void</span> <a class="code" href="fsm__eoe_8h.html#a82f816661734a1e035972b671aafd0c6">ec_fsm_eoe_set_ip_param</a>(<a class="code" href="structec__fsm__eoe.html">ec_fsm_eoe_t</a> *, <a class="code" href="structec__slave.html">ec_slave_t</a> *,</div><div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;        <a class="code" href="structec__eoe__request__t.html">ec_eoe_request_t</a> *);</div><div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;</div><div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;<span class="keywordtype">int</span> <a class="code" href="fsm__eoe_8h.html#a6001c202070faa841d2a0c6b62e72dc9">ec_fsm_eoe_exec</a>(<a class="code" href="structec__fsm__eoe.html">ec_fsm_eoe_t</a> *, <a class="code" href="structec__datagram__t.html">ec_datagram_t</a> *);</div><div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;<span class="keywordtype">int</span> <a class="code" href="fsm__eoe_8h.html#af1df58205e10c1ab404c57f74dd11b37">ec_fsm_eoe_success</a>(<span class="keyword">const</span> <a class="code" href="structec__fsm__eoe.html">ec_fsm_eoe_t</a> *);</div><div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;</div><div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;<span class="comment">/****************************************************************************/</span></div><div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;</div><div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;<span class="preprocessor">#endif</span></div><div class="ttc" id="structec__fsm__eoe_html_af0d524bedc30987253f0f6d9167e4ae0"><div class="ttname"><a href="structec__fsm__eoe.html#af0d524bedc30987253f0f6d9167e4ae0">ec_fsm_eoe::slave</a></div><div class="ttdeci">ec_slave_t * slave</div><div class="ttdoc">slave the FSM runs on </div><div class="ttdef"><b>Definition:</b> <a href="fsm__eoe_8h_source.html#l00052">fsm_eoe.h:52</a></div></div>
<div class="ttc" id="slave_8h_html"><div class="ttname"><a href="slave_8h.html">slave.h</a></div><div class="ttdoc">EtherCAT slave structure. </div></div>
<div class="ttc" id="structec__datagram__t_html"><div class="ttname"><a href="structec__datagram__t.html">ec_datagram_t</a></div><div class="ttdoc">EtherCAT datagram. </div><div class="ttdef"><b>Definition:</b> <a href="datagram_8h_source.html#l00087">datagram.h:87</a></div></div>
<div class="ttc" id="structec__fsm__eoe_html_ac2f84e2d9a8cf4690925918a807c625d"><div class="ttname"><a href="structec__fsm__eoe.html#ac2f84e2d9a8cf4690925918a807c625d">ec_fsm_eoe::request</a></div><div class="ttdeci">ec_eoe_request_t * request</div><div class="ttdoc">EoE request. </div><div class="ttdef"><b>Definition:</b> <a href="fsm__eoe_8h_source.html#l00058">fsm_eoe.h:58</a></div></div>
<div class="ttc" id="fsm__eoe_8h_html_a5a213c261d19d01b080ac54b0d71d863"><div class="ttname"><a href="fsm__eoe_8h.html#a5a213c261d19d01b080ac54b0d71d863">ec_fsm_eoe_clear</a></div><div class="ttdeci">void ec_fsm_eoe_clear(ec_fsm_eoe_t *)</div><div class="ttdoc">Destructor. </div><div class="ttdef"><b>Definition:</b> <a href="fsm__eoe_8c_source.html#l00078">fsm_eoe.c:78</a></div></div>
<div class="ttc" id="globals_8h_html"><div class="ttname"><a href="globals_8h.html">globals.h</a></div><div class="ttdoc">Global definitions and macros. </div></div>
<div class="ttc" id="structec__fsm__eoe_html_a6a5e047634109a65f38f806be2d6c99d"><div class="ttname"><a href="structec__fsm__eoe.html#a6a5e047634109a65f38f806be2d6c99d">ec_fsm_eoe::jiffies_start</a></div><div class="ttdeci">unsigned long jiffies_start</div><div class="ttdoc">Timestamp. </div><div class="ttdef"><b>Definition:</b> <a href="fsm__eoe_8h_source.html#l00057">fsm_eoe.h:57</a></div></div>
<div class="ttc" id="structec__slave_html"><div class="ttname"><a href="structec__slave.html">ec_slave</a></div><div class="ttdoc">EtherCAT slave. </div><div class="ttdef"><b>Definition:</b> <a href="slave_8h_source.html#l00198">slave.h:198</a></div></div>
<div class="ttc" id="fsm__eoe_8h_html_a6001c202070faa841d2a0c6b62e72dc9"><div class="ttname"><a href="fsm__eoe_8h.html#a6001c202070faa841d2a0c6b62e72dc9">ec_fsm_eoe_exec</a></div><div class="ttdeci">int ec_fsm_eoe_exec(ec_fsm_eoe_t *, ec_datagram_t *)</div><div class="ttdoc">Executes the current state of the state machine. </div><div class="ttdef"><b>Definition:</b> <a href="fsm__eoe_8c_source.html#l00105">fsm_eoe.c:105</a></div></div>
<div class="ttc" id="eoe__request_8h_html"><div class="ttname"><a href="eoe__request_8h.html">eoe_request.h</a></div><div class="ttdoc">EtherCAT EoE request structure. </div></div>
<div class="ttc" id="fsm__eoe_8h_html_addd4a112d39ab2ac7dfa3c30d181a2fe"><div class="ttname"><a href="fsm__eoe_8h.html#addd4a112d39ab2ac7dfa3c30d181a2fe">ec_fsm_eoe_init</a></div><div class="ttdeci">void ec_fsm_eoe_init(ec_fsm_eoe_t *)</div><div class="ttdoc">Constructor. </div><div class="ttdef"><b>Definition:</b> <a href="fsm__eoe_8c_source.html#l00062">fsm_eoe.c:62</a></div></div>
<div class="ttc" id="fsm__eoe_8h_html_a82f816661734a1e035972b671aafd0c6"><div class="ttname"><a href="fsm__eoe_8h.html#a82f816661734a1e035972b671aafd0c6">ec_fsm_eoe_set_ip_param</a></div><div class="ttdeci">void ec_fsm_eoe_set_ip_param(ec_fsm_eoe_t *, ec_slave_t *, ec_eoe_request_t *)</div><div class="ttdoc">Starts to set the EoE IP partameters of a slave. </div><div class="ttdef"><b>Definition:</b> <a href="fsm__eoe_8c_source.html#l00088">fsm_eoe.c:88</a></div></div>
<div class="ttc" id="structec__fsm__eoe_html_a9d26ce401611fef24143bdfd1c1937ab"><div class="ttname"><a href="structec__fsm__eoe.html#a9d26ce401611fef24143bdfd1c1937ab">ec_fsm_eoe::state</a></div><div class="ttdeci">void(* state)(ec_fsm_eoe_t *, ec_datagram_t *)</div><div class="ttdoc">EoE state function. </div><div class="ttdef"><b>Definition:</b> <a href="fsm__eoe_8h_source.html#l00055">fsm_eoe.h:55</a></div></div>
<div class="ttc" id="datagram_8h_html"><div class="ttname"><a href="datagram_8h.html">datagram.h</a></div><div class="ttdoc">EtherCAT datagram structure. </div></div>
<div class="ttc" id="structec__eoe__request__t_html"><div class="ttname"><a href="structec__eoe__request__t.html">ec_eoe_request_t</a></div><div class="ttdoc">Ethernet-over-EtherCAT set IP parameter request. </div><div class="ttdef"><b>Definition:</b> <a href="eoe__request_8h_source.html#l00049">eoe_request.h:49</a></div></div>
<div class="ttc" id="fsm__eoe_8h_html_af1df58205e10c1ab404c57f74dd11b37"><div class="ttname"><a href="fsm__eoe_8h.html#af1df58205e10c1ab404c57f74dd11b37">ec_fsm_eoe_success</a></div><div class="ttdeci">int ec_fsm_eoe_success(const ec_fsm_eoe_t *)</div><div class="ttdoc">Returns, if the state machine terminated with success. </div><div class="ttdef"><b>Definition:</b> <a href="fsm__eoe_8c_source.html#l00140">fsm_eoe.c:140</a></div></div>
<div class="ttc" id="structec__fsm__eoe_html_a160de09e919a9acba1428542721dbd27"><div class="ttname"><a href="structec__fsm__eoe.html#a160de09e919a9acba1428542721dbd27">ec_fsm_eoe::retries</a></div><div class="ttdeci">unsigned int retries</div><div class="ttdoc">retries upon datagram timeout </div><div class="ttdef"><b>Definition:</b> <a href="fsm__eoe_8h_source.html#l00053">fsm_eoe.h:53</a></div></div>
<div class="ttc" id="structec__fsm__eoe_html"><div class="ttname"><a href="structec__fsm__eoe.html">ec_fsm_eoe</a></div><div class="ttdoc">Finite state machines for the Ethernet over EtherCAT protocol. </div><div class="ttdef"><b>Definition:</b> <a href="fsm__eoe_8h_source.html#l00051">fsm_eoe.h:51</a></div></div>
<div class="ttc" id="structec__fsm__eoe_html_ab6df3ffa1eaf78631d91aba46525bc3f"><div class="ttname"><a href="structec__fsm__eoe.html#ab6df3ffa1eaf78631d91aba46525bc3f">ec_fsm_eoe::datagram</a></div><div class="ttdeci">ec_datagram_t * datagram</div><div class="ttdoc">Datagram used in the previous step. </div><div class="ttdef"><b>Definition:</b> <a href="fsm__eoe_8h_source.html#l00056">fsm_eoe.h:56</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_c1346cf4828efdd0d2baf0d391d01b77.html">master</a></li><li class="navelem"><a class="el" href="fsm__eoe_8h.html">fsm_eoe.h</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
  </ul>
</div>
</body>
</html>
